FlowStarterPosition Properties
An object defining properties for the FlowStarterPosition class.
TimeoutOptions
Timeout options for managing delays and expiration settings for the starter position.
Type: IFlowTimeoutOptions
Caption
The caption dictionary representing localized captions for the flow object.
Type: Dictionary<string, string>
EnablePushNotification
Gets or sets a value indicating whether push notification is enabled.
Type: bool
ShowInFlowHistory
Specifies if the position should appear in the workflow history.
Type: bool
HideApporoverInHistory
Determines whether the approver should be hidden in the workflow history.
Type: bool
TimeoutHour
The number of hours specified for the timeout duration.
Type: int
GeolocationOptions
Geolocation options associated with the starter position.
Type: IFlowGeolocationOptions
Id
The unique identifier of the starter position.
Type: long
NotificationMessage
Gets the notification message associated with the message.
Type: Dictionary<string, string>
EventsToCheck
A list of events that need to be monitored for the starter position.
MailSubject
Gets the mail subject associated with the message.
Type: Dictionary<string, string>
Key
A unique identifier for the workflow step.
Type: string
AutoOpenApprovalOption
Indicates if approval options should automatically open for this position.
Type: bool
TimeoutMinute
The number of minutes specified for the timeout duration.
Type: int
Code
The code or username associated with the starter position.
Type: string
Name
Name for the workflow step.
Type: string
EnableSendMail
Gets or sets a value indicating whether sending mail is enabled.
Type: bool
Events
A read-only list of events linked to the starter position.
Type: IReadOnlyList<IEvent>
MailMessage
Gets the mail message associated with the message.
Type: Dictionary<string, string>
TimeoutDuration
The total timeout duration represented as a TimeSpan.
Type: TimeSpan
IsCustomMailMessage
Gets or sets a value indicating whether the mail message is custom.
Type: bool
CustomMailMessage
Gets the custom mail message associated with the message.
Type: Dictionary<string, string>
MessageOptions
Gets or sets the message options.
Type: IFlowMessageOptions
RequestIsNecessaryIfDocumentChanged
Specifies if a request is required when the associated document is modified.
Type: bool
Email
The email address of the user in the starter position.
Type: string
Description
A description of the starter position, typically the full name of the user.
Type: string
WorkflowCodeInstance
The workflow code instance associated with the flow object.
Type: IWorkflowCode
Documents
A list of documents associated with the starter position.
CachedDMObjects
The cached document management objects related to the flow object.
Type: IRuntimeDMObjects
WebNotificationOptions
Gets or sets the web notification options.
NotificationCaption
Gets the notification caption associated with the message.
Type: Dictionary<string, string>
Attachments
Gets the list of attachments associated with the message.
Type: IReadOnlyList<string>
TypeCode
The type code associated with the flow object.
Type: WorkflowItemTypeCode
Accepted Values:
Name Value FlowComment -1 FlowStart 10 FlowEnd 11 FlowPosition 15 FlowAssign 21 FlowCompare 22 FlowOr 24 FlowAnd 25 FlowMail 26 FlowProfession 27 FlowDepartment 28 Variable 30 FlowScript 31 FlowNode 33 FlowGroup 37 FlowTimer 39 FlowTimerStarter 40 FlowTimerStopper 41 FlowApprovalCancellar 42 Pauser 44 SubFlowCall 51 SubFlowBegin 52 SubFlowEnd 53 FlowPushNotification 54 FlowDocument 56 FlowCreateDocument 57 FlowDocumentSynchronizer 58 FlowStarterPosition 59 FlowDocumentState 63 FlowUniqueIdCreator 65 FlowSetDocumentId 66 FlowDeleteDocument 67 FlowPDFExport 68 FlowXMLExport 69 FlowMailSender 75 FlowParallel 79 FlowContinue 80 FlowTrigger 81 FlowActionCreator 82 FlowDigitallySigning 83 FlowGptPrompt 84
DoNotSendRequestIfProcessed
Indicates whether requests should be avoided if already processed.
Type: bool
CalculateUsingHolidays
Specifies if holidays should be considered in timeout calculations.
Type: bool
TimeoutDay
The number of days specified for the timeout duration.
Type: int
CalculateUsingWorkingHours
Determines if working hours should be used in timeout calculations.
Type: bool
NotificationOptions
Gets or sets the push notification options.